ExpereAPI Service
This section discusses the operations available in the service, the request and response messages, parameters, and the data types available in the service.
Important: In this documentation, the location (endpoint) for the service is given as the production environment. In your implementation, the endpoint may be a different environment.
Overview
| Web Service | ExpereAPI Service |
|---|---|
| Target Namespec | http://tempuri.org/ (default namespace URI, replace with meaningful URI) |
| Import Namespace | http://schemas.bankerssystems.com/2004/ExpereAPI/ExpereIEServices |
| Port | BasicHttpBinding_IExpereAPI |
| Binding | BasicHttpBinding_IExpereAPI |
| Location | http://[servername]/Expere/ExpereAPI.svc?wsdl |
| Protocol | SOAP |
| Transport Protocol | SOAP over HTTP |
Operations
The ExpereAPI Service is a collection of 74 operations (methods). The following operations and request/response messages are available in the service.
Note: In this guide, services supporting the Integrated Validation Tool are presented in a separate section. Services (operations) supporting the Organizational Policy and Product Setup Application (OPPSA), while publicly exposed in the ExpereAPI, are not presented in this guide.
| Operation | Request/Response |
|---|---|
| AddDocuments | AddDocumentsRequest [input], message=[tns:AddDocumentsRequest] |
| AddDocumentsResponse [output], message=[tns:AddDocumentsResponse] | |
| AddOrganization | AddOrganizationRequest [input], message=[tns:AddOrganizationRequest] |
| AddOrganizationResponse [output], message=[tns:AddOrganizationResponse] | |
| ApplyPoliciesAndReturnTransaction | ApplyPoliciesAndReturnTransaction [input], message=[tns:ApplyPoliciesAndReturnTransactionRequest] |
| ApplyPoliciesAndReturnTransaction [output], message=[tns:ApplyPoliciesAndReturnTransactionResponse] | |
| AssembleDocumentSet | AssembleDocumentSetRequest [input], message=[tns:AssembleDocumentSetRequest] x |
| AssembleDocumentSetResponse [output], message=[tns:AssembleDocumentSetResponse] | |
| AssembleDocuments | AssembleDocumentsRequest [input], message=[tns:AssembleDocumentsRequest] |
| AssembleDocumentsResponse [output], message=[tns:AssembleDocumentsResponse] | |
| AutoSelect | AutoSelectRequest [input], message=[tns:AutoSelectRequest] |
| AutoSelectResponse [output], message=[tns:AutoSelectResponse] | |
| ClearCache | ClearCacheRequest [input], message=[tns:ClearCacheRequest] |
| ClearCacheResponse [output], message=[tns:ClearCacheResponse] | |
| Compile | CompileRequest [input], message=[tns:CompileRequest] |
| CompileResponse [output], message=[tns:CompileResponse] | |
| CompileAll | CompileAllRequest [input], message=[tns:CompileAllRequest] |
| CompileAllResponse [output], message=[tns:CompileAllResponse] | |
| CreateTransaction | CreateTransactionRequest [input], message=[tns:CreateTransactionRequest] |
| CreateTransactionResponse [output], message=[tns:CreateTransactionResponse] | |
| DeleteOrganization | DeleteOrganizationRequest [input], message=[tns:DeleteOrganizationRequest] |
| DeleteOrganizationResponse [output], message=[tns:DeleteOrganizationResponse] | |
| DeleteTransaction | DeleteTransactionRequest [input], message=[tns:DeleteTransactionRequest] |
| DeleteTransactionResponse [output], message=[tns:DeleteTransactionResponse] | |
| Echo | Echo [input], message=[tns:Echo] |
| Echo [output], message=[tns:Echo] | |
| Generate | GenerateRequest [input], message=[tns:GenerateRequest] |
| GenerateResponse [output], message=[tns:GenerateResponse] | |
| GenerateAndSave | GenerateAndSaveRequest [input], message=[tns:GenerateAndSaveRequest] |
| GenerateAndSaveResponse [output], message=[tns:GenerateAndSaveResponse] | |
| GetDocDataRequirements | GetDocDataRequirementsRequest [input], message=[tns:GetDocDataRequirementsRequest] |
| GetDocDataRequirementsResponse [output], message=[tns:GetDocDataRequirementsResponse] | |
| GetDocSetDataRequirements | GetDocSetDataRequirementsRequest [input], message=[tns:GetDocSetDataRequirementsRequest] |
| GetDocSetDataRequirementsResponse [output], message=[tns:GetDocSetDataRequirementsResponse] | |
| GetDocumentSet | GetDocumentSetRequest [input], message=[tns:GetDocumentSetRequest] |
| GetDocumentSetResponse [output], message=[tns:GetDocumentSetResponse] | |
| GetPackageDataRequirements | GetPackageDataRequirementsRequest [input], message=[tns:GetPackageDataRequirementsRequest] |
| GetPackageDataRequirementsResponse [output], message=[tns:GetPackageDataRequirementsResponse] | |
| GetResolvedDocuments | GetResolvedDocumentsRequest [input], message=[tns:GetResolvedDocumentsRequest] |
| GetResolvedDocumentsResponse [output], message=[tns:GetResolvedDocumentsResponse] | |
| GetResolvedPackage | GetResolvedPackageRequest [input], message=[tns:GetResolvedPackageRequest] |
| GetResolvedPackageResponse [output], message=[tns:GetResolvedPackageResponse] | |
| GetServiceInfo | GetServiceInfoRequest [input], message=[tns:GetServiceInfoRequest] |
| GetServiceInfoResponse [output], message=[tns:GetServiceInfoResponse] | |
| GetTransaction | GetTransactionRequest [input], message=[tns:GetTransactionRequest] |
| GetTransactionResponse [output], message=[tns:GetTransactionResponse] | |
| ListAllDocuments | ListAllDocumentsRequest [input], message=[tns:ListAllDocumentsRequest] |
| ListAllDocumentsResponse [output], message=[tns:ListAllDocumentsResponse] | |
| ListAllOrganizations | ListAllOrganizationsRequest [input], message=[tns:ListAllOrganizationsRequest] |
| ListAllOrganizationsResponse [output], message=[tns:ListAllOrganizationsResponse] | |
| ListDocuments | ListDocumentsRequest [input], message=[tns:ListDocumentsRequest] |
| ListDocumentsResponse [output], message=[tns:ListDocumentsResponse] | |
| ListLinesOfBusiness | ListLinesOfBusinessRequest [input], message=[tns:ListLinesOfBusinessRequest] |
| ListLinesOfBusinessResponse [output], message=[tns:ListLinesOfBusinessResponse] | |
| ListOrganizations | ListOrganizationsRequest [input], message=[tns:ListOrganizationsRequest] |
| ListOrganizationsResponse [output], message=[tns:ListOrganizationsResponse] | |
| ListPackages | ListPackagesRequest [input], message=[tns:ListPackagesRequest] |
| ListPackagesResponse [output], message=[tns:ListPackagesResponse] | |
| ListPhases | ListPhasesRequest [input], message=[tns:ListPhasesRequest] |
| ListPhasesResponse [output], message=[tns:ListPhasesResponse] | |
| ListPolicies | ListPoliciesRequest [input], message=[tns:ListPoliciesRequest] |
| ListPoliciesResponse [output], message=[tns:ListPoliciesResponse] | |
| PostProcess | PostProcessRequest [input], message=[tns:PostProcessRequest] |
| PostProcessResponse [output], message=[tns:PostProcessResponse] | |
| RemoveDocuments | RemoveDocumentsRequest [input], message=[tns:RemoveDocumentsRequest] |
| RemoveDocumentsResponse [output], message=[tns:RemoveDocumentsResponse] | |
| ResolveDocData | ResolveDocDataRequest [input], message=[tns:ResolveDocDataRequest] |
| ResolveDocDataResponse [output], message=[tns:ResolveDocDataResponse] | |
| ResolvePkgData | ResolvePkgDataRequest [input], message=[tns:ResolvePkgDataRequest] |
| ResolvePkgDataResponse [output], message=[tns:ResolvePkgDataResponse] | |
| Select | SelectRequest [input], message=[tns:SelectRequest] |
| SelectResponse [output], message=[tns:SelectResponse] | |
| SelectAndGenerate | SelectAndGenerateRequest [input], message=[tns:SelectAndGenerateRequest] |
| SelectAndGenerateResponse [output], message=[tns:SelectAndGenerateResponse] | |
| SelectAndGenerateTestDocuments | SelectAndGenerateTestDocumentsRequest [input], message=[tns:SelectAndGenerateTestDocumentsRequest] |
| SelectAndGenerateTestDocumentsResponse [output], message=[tns:SelectAndGenerateTestDocumentsResponse] | |
| SelectGenerateAndSave | SelectGenerateAndSaveRequest [input], message=[tns:SelectGenerateAndSaveRequest] |
| SelectGenerateAndSaveResponse [output], message=[tns:SelectGenerateAndSaveResponse] | |
| UpdateTransaction | UpdateTransactionRequest [input], message=[tns:UpdateTransactionRequest] |
| UpdateTransactionResponse [output], message=[tns:UpdateTransactionResponse] |